* Gets emitted for every page that is printed. The signal handler
* must render the @page_nr's page onto the cairo context obtained
* from @context using gtk_print_context_get_cairo().
- *
+ *
* <informalexample><programlisting>
* FIXME: need an example here
* </programlisting></informalexample>
*
+ * Use gtk_print_operation_set_use_full_page() and
+ * gtk_print_operation_set_unit() before starting the print operation
+ * to set up the transformation of the cairo context according to your
+ * needs.
+ *
* Since: 2.10
*/
signals[DRAW_PAGE] =
g_cclosure_marshal_VOID__VOID,
G_TYPE_NONE, 0);
+ /**
+ * GtkPrintOperation:default-page-setup:
+ *
+ * The #GtkPageSetup used by default.
+ *
+ * This page setup will be used by gtk_print_operation_run(),
+ * but it can be overridden on a per-page basis by connecting
+ * to the ::request-page-setup signal.
+ *
+ * Since: 2.10
+ */
g_object_class_install_property (gobject_class,
PROP_DEFAULT_PAGE_SETUP,
g_param_spec_object ("default-page-setup",
GTK_TYPE_PAGE_SETUP,
GTK_PARAM_READWRITE));
+ /**
+ * GtkPrintOperation:print-settings:
+ *
+ * The #GtkPrintSettings used for initializing the dialog.
+ *
+ * Setting this property is typically used to re-establish print
+ * settings from a previous print operation, see gtk_print_operation_run().
+ *
+ * Since: 2.10
+ */
g_object_class_install_property (gobject_class,
PROP_PRINT_SETTINGS,
g_param_spec_object ("print-settings",
P_("The GtkPrintSettings used for initializing the dialog"),
GTK_TYPE_PRINT_SETTINGS,
GTK_PARAM_READWRITE));
-
+
+ /**
+ * GtkPrintOperation:job-name:
+ *
+ * A string used to identify the job (e.g. in monitoring applications like eggcups).
+ *
+ * If you don't set a job name, GTK+ picks a default one by numbering successive
+ * print jobs.
+ *
+ * Since: 2.10
+ */
g_object_class_install_property (gobject_class,
PROP_JOB_NAME,
g_param_spec_string ("job-name",
P_("A string used for identifying the print job."),
"",
GTK_PARAM_READWRITE));
-
+
+ /**
+ * GtkPrintOperation:number-of-pages:
+ *
+ * The number of pages in the document.
+ *
+ * This <emphasis>must</emphasis> be set to a positive number
+ * before the rendering starts. It may be set in a ::begin-print signal hander.
+ *
+ * Note that the page numbers passed to the ::request-page-setup and ::draw-page
+ * signals are 0-based, i.e. if the user chooses to print all pages, the last
+ * ::draw-page signal will be for page @n_pages - 1.
+ *
+ * Since: 2.10
+ */
g_object_class_install_property (gobject_class,
PROP_NR_OF_PAGES,
g_param_spec_int ("number-of-pages",
G_MAXINT,
-1,
GTK_PARAM_READWRITE));
-
+
+ /**
+ * GtkPrintOperation:current-page:
+ *
+ * The current page in the document.
+ *
+ * If this is set before gtk_print_operation_run(),
+ * the user will be able to select to print only the current page.
+ *
+ * Note that this only makes sense for pre-paginated documents.
+ *
+ * Since: 2.10
+ */
g_object_class_install_property (gobject_class,
PROP_CURRENT_PAGE,
g_param_spec_int ("current-page",
-1,
GTK_PARAM_READWRITE));
+ /**
+ * GtkPrintOperation:use-full-page:
+ *
+ * If %TRUE, the transformation for the cairo context obtained from
+ * #GtkPrintContext puts the origin at the top left corner of the page
+ * (which may not be the top left corner of the sheet, depending on page
+ * orientation and the number of pages per sheet). Otherwise, the origin
+ * is at the top left corner of the imageable area (i.e. inside the margins).
+ *
+ * Since: 2.10
+ */
g_object_class_install_property (gobject_class,
PROP_USE_FULL_PAGE,
g_param_spec_boolean ("use-full-page",
P_("Use full page"),
- P_(""),
+ P_("%TRUE if the the origin of the context should be at the corner of the page and not the corner of the imageable area"),
FALSE,
GTK_PARAM_READWRITE));
+ /**
+ * GtkPrintOperation:unit:
+ *
+ * The transformation for the cairo context obtained from
+ * #GtkPrintContext is set up in such a way that distances are measured
+ * in units of @unit.
+ *
+ * Since: 2.10
+ */
g_object_class_install_property (gobject_class,
PROP_UNIT,
g_param_spec_enum ("unit",
P_("Unit"),
- P_(""),
+ P_("The unit in which distances can be measured in the context"),
GTK_TYPE_UNIT,
GTK_UNIT_PIXEL,
GTK_PARAM_READWRITE));
+ /**
+ * GtkPrintOperation:show-dialog:
+ *
+ * Determines whether calling gtk_print_operation_run() will present
+ * a print dialog to the user, or just print to the default printer.
+ *
+ * Since: 2.10
+ */
g_object_class_install_property (gobject_class,
PROP_SHOW_DIALOG,
g_param_spec_boolean ("show-dialog",
TRUE,
GTK_PARAM_READWRITE));
+ /**
+ * GtkPrintOperation:pdf-target:
+ *
+ * The name of a PDF file to generate instead of showing the print dialog.
+ *
+ * The indended use of this property is for implementing "Export to PDF"
+ * actions.
+ *
+ * "Print to PDF" support is independent of this and is done
+ * by letting the user pick the "Print to PDF" item from the list
+ * of printers in the print dialog.
+ *
+ * Since: 2.10
+ */
g_object_class_install_property (gobject_class,
PROP_JOB_NAME,
g_param_spec_string ("pdf-target",
NULL,
GTK_PARAM_READWRITE));
+ /**
+ * GtkPrintOperation:status:
+ *
+ * The status of the print operation.
+ *
+ * Since: 2.10
+ */
g_object_class_install_property (gobject_class,
PROP_STATUS,
g_param_spec_enum ("status",
GTK_PRINT_STATUS_INITIAL,
GTK_PARAM_READABLE));
+ /**
+ * GtkPrintOperation:status-string:
+ *
+ * A string representation of the status of the print operation.
+ * The string is translated and suitable for displaying the print
+ * status e.g. in a #GtkStatusbar.
+ *
+ * See the ::status property for a status value that is suitable
+ * for programmatic use.
+ *
+ * Since: 2.10
+ */
g_object_class_install_property (gobject_class,
PROP_STATUS_STRING,
g_param_spec_string ("status-string",
* Sets the number of pages in the document.
*
* This <emphasis>must</emphasis> be set to a positive number
- * before the print dialog is shown. It may be set in a
- * ::begin-print signal hander.
+ * before the rendering starts. It may be set in a ::begin-print
+ * signal hander.
*
* Note that the page numbers passed to the ::request-page-setup
* and ::draw-page signals are 0-based, i.e. if the user chooses
* @current_page: the current page, 0-based
*
* Sets the current page.
+ *
* If this is called before gtk_print_operation_run(),
* the user will be able to select to print only the current page.
*
}
}
+/**
+ * gtk_print_operation_set_use_full_page:
+ * @op: a #GtkPrintOperation
+ * @full_page: %TRUE to set up the #GtkPrintContext for the full page
+ *
+ * If @full_page is %TRUE, the transformation for the cairo context
+ * obtained from #GtkPrintContext puts the origin at the top left
+ * corner of the page (which may not be the top left corner of the
+ * sheet, depending on page orientation and the number of pages per
+ * sheet). Otherwise, the origin is at the top left corner of the
+ * imageable area (i.e. inside the margins).
+ *
+ * Since: 2.10
+ */
void
gtk_print_operation_set_use_full_page (GtkPrintOperation *op,
gboolean full_page)
}
}
+/**
+ * gtk_print_operation_set_unit:
+ * @op: a #GtkPrintOperation
+ * @unit: the unit to use
+ *
+ * Sets up the transformation for the cairo context obtained from
+ * #GtkPrintContext in such a way that distances are measured in
+ * units of @unit.
+ *
+ * Since: 2.10
+ */
void
gtk_print_operation_set_unit (GtkPrintOperation *op,
GtkUnit unit)
}
}
+/**
+ * gtk_print_operation_set_pdf_target:
+ * @op: a #GtkPrintOperation
+ * @filename: the filename for the PDF file
+ *
+ * Sets up the #GtkPrintOperation to generate a PDF file instead
+ * of showing the print dialog. The indended use of this function
+ * is for implementing "Export to PDF" actions.
+ *
+ * "Print to PDF" support is independent of this and is done
+ * by letting the user pick the "Print to PDF" item from the list
+ * of printers in the print dialog.
+ *
+ * Since: 2.10
+ */
void
gtk_print_operation_set_pdf_target (GtkPrintOperation *op,
- const gchar * filename)
+ const gchar *filename)
{
g_return_if_fail (GTK_IS_PRINT_OPERATION (op));
projects / gtk4.git / commitdiff